Get Specific OC Lead for Customer

The Get Specific OC Lead for Customer request retrieves the details of a specific Operator Connect lead.

URL

Copy 
{{baseUrl}}/api/v2/oc/lead?msTenantID={{msTenantId}}

HTTP Method

GET

Request Parameters

Parameter

Type

Description

Filtering

msTenantId

string

The Microsoft Azure subscription Tenant Id of the customer lead.

checkOnline

boolean

default: false

When the parameter checkOnline is set to true, and the msTenantId specified above is not found in the Live Platform database, synchronization is run only for the specified msTenantId .

Pagination

Page Number

integer

Default value: 0

Page number in range to retrieve.

Page Size

integer

Default value: 100

Number of pages in range to retrieve.

Example Response

Copy 
[
    {
        "civicAddresses": null,
        "comments": null,
        "umpCustomerGuid": null,
        "isNotActive": null,
        "ovocChannelId": null,
        "isDirectLead": true,
        "id": "da68eafc-d3c6-4d3b-9a10-c48b26c6086b",
        "tenantId": "f94238e5-4f2c-4e1b-8125-2d27122ca75f",
        "tenantOrigin": null,
        "operatorId": null,
        "status": "Active",
        "consentedOn": "2024-04-03T13:32:12.8286742Z",
        "lastModifiedOn": "2024-04-03T13:32:12.82872Z",
        "consentedCountries": [],
        "contactDetails": {
            "fullName": null,
            "email": null,
            "phoneNumber": null,
            "companyName": "SIPTest",
            "companySize": null
        },
        "contacts": null
    }
]

HTTP Responses

■ 200 OK

Parameters

Type

Description

civicAddresses

dictionary

Dictionary including the following values:

■ id
■ country
■ houseNumber
■ houseNumberSuffix
■ preDirectional
■ streetName
■ streetSuffix
■ postDirectional
■ stateOrProvince
■ countyOrDistrict
■ cityOrTown
■ cityOrTownAlias
■ postalOrZipCode
■ description
■ companyName
■ companyId
■ defaultLocationId
■ validationStatus
■ tenantId
■ partnerId
■ locations:
✔ id
✔ civicAddressId
✔ description
✔ additionalInfo
✔ isDefault
✔ elin

comments

list

Any comments added by the operator regarding the lead.

umpCustomerGuid

string($uuid)

This id is created on the Live Platform database for the customer tenant when a Live Platform license is applied. If this field is null, a license has not yet been applied to the lead.

isNotActive

boolean

Indicates whether the customer has an active license i.e. OC Essential

ovocChannelId

null

The Tenant Id of the channel for which the lead is attached.

isDirectLead

Boolean

Indicates whether the lead was created as a Consentless lead.

id

string

Internal Id generated by Live Platform; used for debugging purposes.

tenantId

string

The Microsoft Azure Tenant Id of the customer lead.

tenantOrigin

string

Office365

operatorId

string

Id of the operator performing Onboarding with Global Admin or Service account permissions.

status

string
■ Active: Customer is activated on Microsoft
■ Not Active: Customer is not activated on Microsoft
■ OC Essential: OC Essential License has been applied to customer

consentedOn

string ($date-time)

The date of consent by Operator.

lastModifiedOn

string ($date-time)

The last date of modification by Operator.

consentedCountries

dictionary

The countries for which the customer consented to activate user calling (as configured in their Teams admin center).

contactDetails

dictionary

List array including the following:

■ fullName
■ email
■ phoneNumber
■ companyName
■ companySize

fullName

string

The full name of the customer lead.

email

string

The customer lead email address.

phoneNumber

string

The customer lead phone number.

companyName

string

The name of the company of the customer lead.

companySize

string

The number of employees of the customer lead.

contacts

dictionary

strings

Dictionary including the following:

■ fullName
■ email
■ phoneNumber
■ companySize

fullName

string

Full name of the customer Global administrator contact or Service account contact.

email

string

Email of the customer Global administrator contact or Service account contact.

phoneNumber

string

Phone Number of the customer Global administrator contact or Service account contact.

companySize

string

The number of employees of the customer lead.
■ 400 Bad Request

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk"

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 404 Not Found: string
■ 500 Internal Server Error

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk"

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"